Update install scheme pages to reflect selected Cloud URL#286
Merged
aimichelle merged 7 commits intopixie-io:mainfrom Jul 12, 2024
Merged
Conversation
Signed-off-by: Dom Del Nano <ddelnano@gmail.com> (cherry picked from commit 58a19b0)
Signed-off-by: Dom Del Nano <ddelnano@gmail.com>
✅ Deploy Preview for docs-px-dev ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
aimichelle
reviewed
Jul 11, 2024
| interface Props { | ||
| interface Props { } | ||
|
|
||
| export const CliDeployInstructions: React.FC<Props> = () => { |
Member
There was a problem hiding this comment.
Maybe you can make this a generic TemplatedCodeBlock component which takes the desired commands a prop:
<TemplatedCodeBlock
code={`
# List Pixie deployment options.
px deploy --help
# Deploy the Pixie Platform in your K8s cluster (No OLM present on cluster).
export PL_CLOUD_ADDR=@@`
}
/>
Let me know if that makes sense/if you need any help with that.
Member
Author
There was a problem hiding this comment.
Thanks for this suggestion! I didn't realize that passing as a prop would be different than accepting the string from within a component's tags.
I've updated this to reflect this and also made changes to the Helm and YAML install pages as well. I would recommend reviewing my later changes commit by commit since I made another few adjustments along the way: renaming @@ to @PLACEHOLDER and renaming PL_ -> PX_.
…void MDX library issues Signed-off-by: Dom Del Nano <ddelnano@gmail.com>
…or drop down Signed-off-by: Dom Del Nano <ddelnano@gmail.com>
Signed-off-by: Dom Del Nano <ddelnano@gmail.com>
Signed-off-by: Dom Del Nano <ddelnano@gmail.com>
ddelnano
changed the title
ddelnano
commented
Jul 11, 2024
Comment on lines
+109
to
110
| px deploy --help \n | ||
| # Deploy the Pixie Platform in your K8s cluster (No OLM present on cluster). |
Member
Author
There was a problem hiding this comment.
@aimichelle leaving the empty lines in this template string caused the following compilation issues:
ERROR #11321 PLUGIN
"gatsby-plugin-mdx" threw an error while running the onCreateNode lifecycle:
unknown: Unexpected token, expected "{" (1:7)
> 1 | export PX_CLOUD_ADDR=@PLACEHOLDER@
| ^
2 | px deploy --extract_yaml ./ --deploy_key <PIXIE_DEPLOYMENT_KEY> --deploy_olm=false \n
3 | # Extract YAML (Self-hosting Pixie Cloud).
4 | px deploy --extract_yaml ./ --deploy_key <PIXIE_DEPLOYMENT_KEY> --dev_cloud_namespace plc \n/home/ddelnano/code/docs.px.dev/content/en/02-installing-pixie/04-install-schemes/02-yaml.md: unknown: Unexpected token, expected "{" (1:7)
> 1 | export PX_CLOUD_ADDR=@PLACEHOLDER@
| ^
2 | px deploy --extract_yaml ./ --deploy_key <PIXIE_DEPLOYMENT_KEY> --deploy_olm=false \n
3 | # Extract YAML (Self-hosting Pixie Cloud).
4 | px deploy --extract_yaml ./ --deploy_key <PIXIE_DEPLOYMENT_KEY> --dev_cloud_namespace plc \n
31 | const createAndProcessNode = path => {
32 | const fileNodePromise = createFileNode(path, createNodeId, pluginOptions).then(fileNode => {
> 33 | createNode(fileNode);
| ^
34 | return null;
35 | });
36 | return fileNodePromise;
File: node_modules/gatsby-source-filesystem/gatsby-node.js:33:7
SyntaxError: unknown: Unexpected token, expected "{" (1:7)
> 1 | export PX_CLOUD_ADDR=@ 9mPLACEHOLDER@
| ^
2 | px deploy --extract_yaml ./ --deploy_ke y <PIXIE_DEPLOYMENT_KEY> --deploy_olm=false [39m \n
3 | # Extract YAML (Self-hosting Pixie Cloud).
4 | px deploy --extract_yaml ./ --deploy_ke y <PIXIE_DEPLOYMENT_KEY> --dev_cloud_namespace plc 1m\n/home/ddelnano/code/docs.px.dev/content/en/02-installing-pixie/04-instal l-schemes/02-yaml.md: unknown: Unexpected token, expected "{" (1:7)
> 1 | export PX_CLOUD_ADDR=@ 9mPLACEHOLDER@
| ^
2 | px deploy --extract_yaml ./ --deploy_ke y <PIXIE_DEPLOYMENT_KEY> --deploy_olm=false [39m \n
3 | # Extract YAML (Self-hosting Pixie Cloud).
4 | px deploy --extract_yaml ./ --deploy_ke y <PIXIE_DEPLOYMENT_KEY> --dev_cloud_namespace plc 1m\n
SyntaxError: unknown: Unexpected token, expected "{" (1:7)
> 1 | export PX_CLOUD_ADDR=@ 9mPLACEHOLDER@
| ^
2 | px deploy --extract_yaml ./ --deploy_ke y <PIXIE_DEPLOYMENT_KEY> --deploy_olm=false [39m \n
3 | # Extract YAML (Self-hosting Pixie Cloud).
4 | px deploy --extract_yaml ./ --deploy_ke y <PIXIE_DEPLOYMENT_KEY> --dev_cloud_namespace plc 1m\n/home/ddelnano/code/docs.px.dev/content/en/02-installing-pixie/04-instal l-schemes/02-yaml.md: unknown: Unexpected token, expected "{" (1:7)
> 1 | export PX_CLOUD_ADDR=@ 9mPLACEHOLDER@
| ^
2 | px deploy --extract_yaml ./ --deploy_ke y <PIXIE_DEPLOYMENT_KEY> --deploy_olm=false [39m \n
3 | # Extract YAML (Self-hosting Pixie Cloud).
4 | px deploy --extract_yaml ./ --deploy_ke y <PIXIE_DEPLOYMENT_KEY> --dev_cloud_namespace plc 1m\n
Adding \n here was required to keep the line spacing the same. The other thing I tried was adding \n on its own line, but that introduces more spacing than the approach I took as seen in the highlighted text below
If you have any suggestions here, let me know.
aimichelle
reviewed
Jul 12, 2024
Signed-off-by: Dom Del Nano <ddelnano@gmail.com>
aimichelle
approved these changes
Jul 12, 2024
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary: Update install scheme pages to reflect selected Cloud URL
This updates the CLI, Helm and YAML install scheme pages so that the instructions are copy and paste-able. See the screenshots below for the before and after.
Before:
After: